// EnergyPlus, Copyright (c) 1996-2025, The Board of Trustees of the University of Illinois,
// The Regents of the University of California, through Lawrence Berkeley National Laboratory
// (subject to receipt of any required approvals from the U.S. Dept. of Energy), Oak Ridge
// National Laboratory, managed by UT-Battelle, Alliance for Sustainable Energy, LLC, and other
// contributors. All rights reserved.
//
// NOTICE: This Software was developed under funding from the U.S. Department of Energy and the
// U.S. Government consequently retains certain rights. As such, the U.S. Government has been
// granted for itself and others acting on its behalf a paid-up, nonexclusive, irrevocable,
// worldwide license in the Software to reproduce, distribute copies to the public, prepare
// derivative works, and perform publicly and display publicly, and to permit others to do so.
//
// Redistribution and use in source and binary forms, with or without modification, are permitted
// provided that the following conditions are met:
//
// (1) Redistributions of source code must retain the above copyright notice, this list of
//     conditions and the following disclaimer.
//
// (2) Redistributions in binary form must reproduce the above copyright notice, this list of
//     conditions and the following disclaimer in the documentation and/or other materials
//     provided with the distribution.
//
// (3) Neither the name of the University of California, Lawrence Berkeley National Laboratory,
//     the University of Illinois, U.S. Dept. of Energy nor the names of its contributors may be
//     used to endorse or promote products derived from this software without specific prior
//     written permission.
//
// (4) Use of EnergyPlus(TM) Name. If Licensee (i) distributes the software in stand-alone form
//     without changes from the version obtained under this License, or (ii) Licensee makes a
//     reference solely to the software portion of its product, Licensee must refer to the
//     software as "EnergyPlus version X" software, where "X" is the version number Licensee
//     obtained under this License and may not use a different name for the software. Except as
//     specifically required in this Section (4), Licensee shall not use in a company name, a
//     product name, in advertising, publicity, or other promotional activities any name, trade
//     name, trademark, logo, or other designation of "EnergyPlus", "E+", "e+" or confusingly
//     similar designation, without the U.S. Department of Energy's prior written consent.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
// IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
// AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.

// PCM Thermal Storage Module - PCMThermalStorage.hh

#ifndef ENERGYPLUS_PCMTHERMALSTORAGE_HH
#define ENERGYPLUS_PCMTHERMALSTORAGE_HH

#include <EnergyPlus/Data/EnergyPlusData.hh>
#include <EnergyPlus/PhaseChangeModeling/HysteresisModel.hh>
#include <EnergyPlus/Plant/PlantLocation.hh>
#include <EnergyPlus/PlantComponent.hh>
#include <string>

namespace EnergyPlus {
namespace PCMStorage {

    struct PCMStorageData : public PlantComponent
    {
        // Initialization flags
        bool Initialized = false;
        bool MyPlantScanFlag = true;
        bool MyEnvrnFlag = true;

        // Inputs
        std::string Name;
        std::string AvailabilityScheduleName;
        int PCMMaterialNum = 0;                          // Index to PCM material
        Material::MaterialPhaseChange *PCMmat = nullptr; // Pointer to PCM material
        Real64 TankCapacity = 0.0;                       // kg
        Real64 HeatLossRate = 0.0;                       // W
        Real64 MeltingTemp = 0.0;                        // C (gets overwritten by PCMmat->peakTempMelting)
        Real64 FreezingTemp = 0.0;                       // C
        Real64 LatentHeat = 0.0;                         // J/kg (typically from PCMmat)
        Real64 SpecificHeat = 0.0;                       // J/kg-K (backup if needed)
        static constexpr Real64 Effectiveness = 0.9;     // HX effectiveness (optional input)

        // Plant loop connection info
        EnergyPlus::PlantLocation sourcePlantLoc;
        int PlantSideInletNode = 0;
        int PlantSideOutletNode = 0;
        EnergyPlus::PlantLocation usePlantLoc;
        int UseSideInletNode = 0;
        int UseSideOutletNode = 0;

        // Schedule reference
        Sched::Schedule *AvailabilitySchedule = nullptr;

        // Dynamic State Variables
        Real64 PCM_TankTemp = 0.0;       // C, estimated from enthalpy
        Real64 EnergyStored = 0.0;       // J
        Real64 PercentCapacity = 0.0;    // %
        Real64 HeatLossRate_W = 0.0;     // W
        Real64 useheatTransfer = 0.0;    // W
        Real64 plantheatTransfer = 0.0;  // W
        Real64 DesignMassFlowRate = 0.0; // kg/s
        Real64 UseSideDesignFlowRate = 0.0;
        Real64 PlantSideDesignFlowRate = 0.0;
        Real64 UseSideMassFlowRate = 0.0;
        Real64 PlantSideMassFlowRate = 0.0;

        // Required functions
        void Init(EnergyPlusData &state);
        void Calculate(EnergyPlusData &state, PlantLocation const &plantLoc);

        // Singleton instance and factory
        static PCMStorageData &instance();
        static PlantComponent *factory(EnergyPlusData &state, std::string const &objectName);

        // Overrides from PlantComponent
        void
        simulate(EnergyPlusData &state, const PlantLocation &calledFromLocation, bool FirstHVACIteration, Real64 &CurLoad, bool RunFlag) override;

        void oneTimeInit(EnergyPlusData &state) override;
    };

    // Global functions
    void SimulatePCMStorage(EnergyPlusData &state, PlantLocation const &plantLoc, bool FirstHVACIteration, Real64 &CurLoad, bool RunFlag);

    void GetPCMStorageInput(EnergyPlusData &state);
    void RegisterPCMStorageOutputVariables(EnergyPlusData &state);

} // namespace PCMStorage
} // namespace EnergyPlus

#endif // ENERGYPLUS_PCMTHERMALSTORAGE_HH
